Skip to main content

Update Account

The Update Account API notifies the subscriber with account details when the status of an account is updated by the subscriber.

The response for this callback notification from the subscriber should be 200 for a successfull delivery of notification. If the response is other than 200, it is meant as failed status of notification. Hence, the notification is sent for ‘n’ number of times till getting the response as 200. If still the response is not 200, the subscription for this event will be cancelled.

Example

Request Parameters
ParameterDescription
source
Mandatory
String
Source or origin of the event
Constant value: "PL"
eventId
Mandatory
String
Identifier for the event associated with the update
Sample value: "EVT1358242"
eventName
Mandatory
String
Name of the event
Constant value: "Account.UPDATE"
groupId
Mandatory
Array[String]
List of group IDs associated with the event. Useful for tracing related account updates.
Sample value: ["100000000002003","200570414017867","900885266513523"]
payload
Mandatory
Object
idString
Unique ID of the account
Sample value: "1356001"
nameString
Name of the account
Sample value: "General Account"
numberString
Account number
Sample value: "200570414017867"
createdDateString
Date and time of account creation
Sample value: "2025-06-18T13:11:25.438Z"
updatedDateString
Date and time of last update
Sample value: "2025-09-05T16:04:56.478Z"
balanceNumber
Current balance of the account
Sample value: 6070
lowWatermarkValueNumber
Lower watermark threshold for balance notifications
Sample value: 7000
highWatermarkValueNumber
Upper watermark threshold for balance notifications
Sample value: 15000
customerIDString
Customer ID assigned to the account
Sample value: "100000000002003"
customerNameString
Name of the customer associated with the account
Sample value: "Bala"
accountTypeString
Type of account
Sample value: "SAVINGS"
currencyString
Currency of the account
Sample value: "USD"
currencyCodeString
ISO 4217 currency code
Sample value: "840"
statusString
Current status of the account
Sample value: "ACTIVE"
programString
Product associated with the account
Sample value: "DEFAULT"
accountLevelString
Service level associated with the account
Sample value: "DEFAULT"
signature

Mandatory
String
Sign the request payload (params.payload) using private key.
Sample Value: "MEQCIAbpxHpdOyBEVlmxPYv7m4Z1OvWJJYw7g7u3GE3T9nmvAiBjKHckSvb1M6O4t7FeWsn2z9Y3dMeYn3HyX/k28ek/Dw=="

Body


{
"source": "PL",
"eventId": "EVT1358242",
"eventName": "Account.UPDATE",
"groupId": [
"100000000002003",
"200570414017867",
"900885266513523"
],
"payload": {
"accountLevel": "DEFAULT",
"accountType": "SAVINGS",
"balance": 6070,
"createdDate": "2025-06-18T13:11:25.438Z",
"currency": "USD",
"currencyCode": "840",
"customerID": "100000000002003",
"customerName": "Bala",
"lowWatermarkValue": 7000,
"highWatermarkValue": 15000,
"name": "General Account",
"number": "200570414017867",
"program": "DEFAULT",
"status": "ACTIVE",
"updatedDate": "2025-09-05T16:04:56.478Z"
},
"signature": "{{Signature}}"
}

Response: 200


{
//The response for this callback notification from the subscriber should be 200 for a successfull delivery of notification. If the response is other than 200, it is meant as failed status of notification. Hence, the notification is sent for ‘n’ number of times till getting the response as 200. If still the response is not 200, the subscription for this event will be cancelled.
}